home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / enved120.arc / ENVED.DOC next >
Text File  |  1986-11-06  |  11KB  |  278 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.         ENVED
  15.         -----
  16.  
  17.         The MS-DOS Environment String Editor
  18.  
  19.  
  20.         Version 1.20
  21.  
  22.         Copyright 1986 by Scott Robert Ladd.
  23.         All Rights Reserved.
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.          a SHAREWARE product of:
  35.         -------------------------
  36.             Scott Robert Ladd
  37.                    and
  38.                  Elegant
  39.                Technologies
  40.  
  41.             690 Pearl St.  #8
  42.           Denver, CO 80203-4904
  43.         -------------------------
  44.  
  45.  
  46.  
  47.  
  48.  
  49.         Introduction
  50.         ------------
  51.  
  52.              EnvEd is a simple text-editor designed to modify and create
  53.         MS-DOS environment strings.
  54.  
  55.              For those users unfamiliar with the uses and purpose of
  56.         environment strings, they are named text strings stored in
  57.         memory by DOS, which can be accessed by DOS commands and other
  58.         programs. Examples of environment strings are COMSPEC (used by
  59.         DOS to determine where COMMAND.COM can be loaded from), PATH
  60.         (the directory search path used by DOS to find executable
  61.         programs) and PROMPT (the user-defined prompt format). Some
  62.         environment strings are created by their own special commands
  63.         (such as PATH and PROMPT), or by the DOS SET command. For
  64.         details on the SET, PROMPT, and other environment string
  65.         commands, please reference your MS/PC-DOS manual.
  66.  
  67.               A "master" copy of the current environment strings is stored
  68.         in your PC's memory, and a copy of it is made for every program
  69.         executed. The program can then access its own copies of these
  70.         strings, and determine their values. For example, a program
  71.         might use an environment string call "TEMP", which would be
  72.         defined by the set command to be the drive/directory path where
  73.         temporary files might be stored. Many software products use
  74.         environment strings to store information such as terminal types;
  75.         most compilers and program development tools use environment
  76.         strings to tell them where to find libraries, source code, and
  77.         other items. A list of the current environment strings can be
  78.         displayed at the DOS prompt by entering the command SET without
  79.         parameters.
  80.  
  81.              What ENVED does is allow the user to create/modify/delete
  82.         the master environment strings interactively, with a simple
  83.         editor. Under DOS, if a small change is made to an existing
  84.         environment string, the entire string must be re-typed.
  85.  
  86.  
  87.         System Requirements
  88.         -------------------
  89.  
  90.              This version of ENVED requires an IBM-PC compatible with at
  91.         least 96K of RAM (it uses approximately 20K of RAM by itself),
  92.         and MS/PC-DOS version 2.0 or later. The program has worked with
  93.         IBM monochrome, CGA, and EGA video adapters. A version is
  94.         available for the Texas Instruments Professional Computer.
  95.  
  96.              For the record, ENVED was written in Logitech Modula-2/86
  97.         version 2.0x.
  98.  
  99.  
  100.  
  101.  
  102.  
  103.         Invoking ENVED
  104.         --------------
  105.  
  106.              Syntax for executing ENVED is very simple. At the DOS
  107.         prompt, enter:
  108.  
  109.              ENVED string_name [/S]
  110.  
  111.         where string_name is the name of the environment string that you
  112.         either wish to edit or create. If you have a color monitor card
  113.         which does not suffer from "snow" (small, random specs of
  114.         color), such as the Enhanced Graphics Adapter (EGA), use ENVED
  115.         or the SET command to create an environment variable named SNOW,
  116.         set to a value of "NO". This can be done with the following DOS
  117.         SET command at the DOS prompt or in a batch file (such as
  118.         AUTOEXEC.BAT):
  119.                         SET SNOW=NO
  120.  
  121.  
  122.         The ENVED Display
  123.         -----------------
  124.  
  125.              ENVED clears the screen, and displays a heading message. If
  126.         the string_name (see above) was not entered, it will display a
  127.         short "syntax is" message, and return you to the DOS prompt.
  128.         Otherwise, it displays the name of the string being edited and a
  129.         four-line editor. If the string_name already exists, the box
  130.         will contain its current value; otherwise, the editor box will
  131.         be blank. Now, you're ready to edit!
  132.  
  133.  
  134.         What Does What When Editing
  135.         ---------------------------
  136.  
  137.              Any standard, displayable text character entered from the
  138.         keyboard will be inserted into the text in the editor box at the
  139.         current cursor position. ENVED does not have a "type-over" mode.
  140.         Also, the following keys on the PC keyboard have special
  141.         functions (presuming Num Lock is OFF):
  142.  
  143.             Left Arrow  -- Moves the cursor one character to the left
  144.             Right Arrow -- Moves the cursor one character to the right
  145.             Up Arrow    -- Moves the cursor up one line in the editor box
  146.             Down Arrow  -- Moves the cursor down one line in the box
  147.  
  148.             END    -- Moves the cursor to the end of the string
  149.             HOME   -- Moves the cursor to the beginning of the string
  150.  
  151.             <--    -- delets the character to the left of the cursor
  152.             DEL    -- deletes the character under the cursor
  153.  
  154.             ALT-C  -- Clears the entire string (fills it with spaces)
  155.             ALT-U  -- UNDO. Restores the string to its original value
  156.  
  157.         Note that the window is wrapped; in effect, it is one long, 312-
  158.         character string. This has some small advantage, since the DOS
  159.         set command only allows the user to create a variable of at most
  160.         about 100 characters.
  161.  
  162.  
  163.  
  164.  
  165.         What Does What When Editing (continued)
  166.         ---------------------------------------
  167.  
  168.         Once the string is displayed, use the above keystrokes to modify
  169.         what is on the screen. When you see the result you want, press
  170.         the ESC (Escape) key. You will then be asked whether you wish to
  171.         save the current variable; pressing "Y" will change the variable
  172.         in memory, while pressing "N" will abandon whatever changes you
  173.         have made, and leave the environment just like it was before you
  174.         invoked ENVED. ENVED is now done.
  175.  
  176.  
  177.         Deleting a String with ENVED
  178.         ----------------------------
  179.  
  180.         If you use ENVED to edit an existing environment string, and
  181.         then delete all of its contents (such as with the ALT-C key), it
  182.         will be DELETED from the environment by ENVED.
  183.  
  184.         CAUTION:
  185.             Do not use the DOS SET command to delete long environment
  186.             strings created by ENVED. For some strange reason, SET
  187.             deletes only the first 256 characters, leaving a "tail" in
  188.             memory from the string. To delete an environment string,
  189.             edit it with ENVED, press ALT-C, and then ESC and "Y".
  190.  
  191.  
  192.         Creating a String with ENVED
  193.         ----------------------------
  194.  
  195.         If the string_name used when executing ENVED does not exist in
  196.         the current environment, ENVED assumes you wish to create it.
  197.         You will be presented with a blank editor box; should you not
  198.         want to create the string, simply press ESC and "N".
  199.  
  200.  
  201.  
  202.         ENVED License
  203.         -------------
  204.  
  205.              ENVED is the copyrighted product of Scott Robert Ladd and
  206.         Elegant Technologies. You are granted a limited license to use
  207.         ENVED, and copy it and distribute it, provided that the
  208.         following conditions are met:
  209.  
  210.         1) No fee may be charged for such copying and distribution.
  211.            Non-profit organizations, such as User's Groups, are exempt
  212.            from this clause.
  213.  
  214.         2) ENVED may only be distributed with its documentation, in an
  215.            unmodified condition.
  216.  
  217.         If you should decide to use ENVED on a regular basis, you are
  218.         required to register your copy. This costs $5.00. Please send
  219.         your payment, name, address, and phone number to:
  220.  
  221.                     Scott Robert Ladd
  222.                     690 Pearl St. #8
  223.                     Denver, Co 80203-4904
  224.  
  225.              Please make any checks payable to "Scott Robert Ladd"  (the
  226.         state of Colorado is being slow with my business paperwork).
  227.              Registration gives you the right to use and install ENVED
  228.         on up to three machines owned by the individual, company, or
  229.         government agency who is named when the product is registered.
  230.         Also, you have the right to upgrade your copy of ENVED at any
  231.         time, either from Elegant Technologies, or by some other service
  232.         such as a bulletin board. You will also be placed on our mailing
  233.         list, to receive news of updates and new products (unless you
  234.         request otherwise).
  235.  
  236.             I am currently completing a general DOS utilities package for
  237.         release in January of 1987. This package will include ENVED, as
  238.         well as other useful utilities, for a cost of $25.00. If you
  239.         register a copy of ENVED, you will receive notification of the
  240.         release of the "LADD Utilities", as well as a $5.00 credit
  241.         towards their purchase.
  242.              Also coming in the future from Scott Ladd and Elegant
  243.         Technologies:
  244.  
  245.                 SCRIBE -- A word processor for the professional
  246.                           writer (Late 1986)
  247.                 ABACUS -- A scientific / engineering calculator
  248.                           and spreadsheet (Mid-1987)
  249.  
  250.         REMEMBER:
  251.              "Shareware" was created to keep the cost of software down.
  252.              Only you, by registering your shareware products, can make
  253.              it work.
  254.  
  255.         The author can be contacted at the address listed above, or on
  256.         the following BBS system in Colorado:
  257.  
  258.                     The Grizzly King BBS
  259.                     Bob McDuffee / Jeff Phillips, sysops
  260.                     Scott Robert Ladd, co-sysop programming conference
  261.                     (303) 666-0824
  262.  
  263.  
  264.  
  265.  
  266.         Version History
  267.         ---------------
  268.  
  269.         Version    Date    Reason
  270.         -------  --------  --------------------------------------------
  271.           1.0    10/23/86  Original version
  272.  
  273.           1.1    11/02/86  Added ALT-U to restore the original value.
  274.                            Added ALT-C to clear (erase) the value.
  275.  
  276.           1.2    11/06/86  Recompiled with faster screen library. No
  277.                            functional changes.
  278.